12.1 新增终端信息

请求参数

Path: /api/v1/device/create

Method: POST

接口描述:

  1. 新增一条终端信息。
  2. 如果终端已存在,则不会新增,返回失败。
  3. 判断终端已存在的规则:
    • 请求参数中含有 externalId 在设备上已存在终端中,匹配到了相同 externalId 的终端。
    • 根据控制台设置的【终端匹配规则】,mac、计算机名称 与设备上已存在的终端一致。
  4. 接口适用于 v2.2.7 及以上版本。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注 其他信息
mac string[] 必须 MAC地址 支持传入多个MAC地址
deviceType string 必须 设备类型:'PC' PC端,'Mobile' 移动端
name string 非必须 计算机名称 可通过 hostname 指令获取,当管理员开启【终端管理】->【终端列表】->【终端匹配规则】->【终端名称】时,则该项必填
externalId string 非必须 外部ID,例如,可传入外部系统中的终端资产编号 不填写则自动生成
assetType string 非必须 NONE 资产类型:'CYOD' 企业终端,'BYOD' 个人终端,'COPE' 企业纳管个人终端,'NONE' 未定义
tagList string[] 非必须 标签 若标签不存在,则自动创建此标签

请求示例

{
    "mac": ["FE-FC-FE-21-F5-D1", "FE-FC-FE-21-F5-D2"],
    "deviceType": "PC",
    "name": "DESKTOP-I3ABQBS",
    "externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7",
    "assetType": "BYOD",
    "tagList": ["开发测试终端", "办公网终端"]
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示失败
data object 必须 响应数据
├─ externalId string 必须 外部ID
msg string 必须 描述信息
traceId string 必须 调用链ID,链路请求的标识  

返回示例

{
    "code": 0,
    "data": {
        "externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7"
    },
    "msg": "请求成功",
    "traceId": "0022c672e4c8b0d6"
}

错误信息

错误提示 错误码
MAC地址格式错误 7201
不支持的设备类型 7201
请输入设备类型 7201
请输入MAC地址 7201
不支持的资产类型 7201
标签只允许输入中文、字母、数字、下划线和横杠 7201
标签最多可输入%d个字 7201
外部ID中不能含有非法的特殊字符:换行符,制表符,回车符 7201
外部ID长度超过最大上限:%d 7201
终端名称长度超过最大上限:%d 7201
请输入MAC地址 37400400
MAC地址数超过最大上限: %d 37400401
获取终端匹配规则失败 10000003
终端名称不能为空 37400403
终端已存在 37400402
当前终端可选标签数量已达上限: %d 37400405
无法新增标签(%s),最多可存在%d个标签 37400406
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""